home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / public / shar / README < prev    next >
Text File  |  1994-08-01  |  4KB  |  107 lines
  1.  
  2.                  toolbox/public/shar README
  3.  
  4.      This directory contains shar -- a utility for building a shell
  5.      archive.  A shell archive is a single file which contains a
  6.      collection of other files and/or directories which can be extracted
  7.      by /bin/sh.  It is frequently used to send collections of files
  8.      through e-mail.  This software is public domain, and may be
  9.      distributed and/or modified freely.
  10.  
  11.      To compile and install shar, copy this directory to a local disk,
  12.      and type:
  13.  
  14.           su
  15.           make install
  16.  
  17.      This will install shar into your /usr/local/bin directory,
  18.      and the man pages for shar and traverse.
  19.  
  20.      The "shar.shar" file is an archive of the original shar distribution.
  21.  
  22.      Typical usage is:
  23.  
  24.           shar -v file1 file2 ... file > shar.files
  25.  
  26.      To extract the files:
  27.  
  28.           chmod 555 shar.files
  29.           shar.files
  30.  
  31.      The following is a copy of the shar man page.
  32.  
  33.      -----------------------------------------------------------------
  34.  
  35.  
  36.      NAME
  37.           shar - create file storage archive for extraction by /bin/sh
  38.  
  39.      SYNOPSIS
  40.           shar [-abcsv] [-d delim] [-p prefix] files
  41.  
  42.      DESCRIPTION
  43.           shar prints its input files with special command lines
  44.           around them to be used by the shell, /bin/sh , to extract
  45.           them later.  The output can be filtered through the shell to
  46.           recreate copies of the original files.
  47.  
  48.           shar allows directories to be named, and shar prints the
  49.           necessary commands (mkdir & cd) to create new directories
  50.           and fill them.  shar will emit commands to make executable
  51.           plain files executable.  shar will not allow existing files
  52.           such files must be removed by the file extractor.
  53.  
  54.      OPTIONS
  55.           -a   All the options.  The options:  -v -c -b -p <tab>X are
  56.                implied.
  57.  
  58.           -s   Silent running.  All checking and extra output is
  59.                inhibited.
  60.  
  61.           -v   Print verbose feedback messages about what shar is
  62.                doing to be printed during extraction.  Sizes of plain
  63.                files are echoed to allow a simple validity check.
  64.  
  65.           -c   Check file size on extraction by counting characters.
  66.                An error message is reported to the person doing the
  67.                extraction if the sizes don't match.  One reason why
  68.                the sizes may not match is that shar will append a
  69.                newline to complete incomplete last lines; shar prints
  70.                a message that mentions added newlines.  Another reason
  71.                why the sizes may not match is that some network mail
  72.                programs remove non-whitespace control characters.
  73.                shar prints a message that mentions control characters
  74.                to the extractor.
  75.  
  76.           -b   Extract files into basenames so that files with
  77.                absolute path names are put into the current directory.
  78.                This option has strange effects when directories are
  79.                archived.
  80.  
  81.           -d   Use this as the ``end of file'' delimiter instead of
  82.                the default.  The only reason to change it is if you
  83.                suspect an file contains the default delimiter:
  84.                SHAR_EOF.
  85.  
  86.           -p   Use this as the prefix to each line of the archived
  87.                files.  This is to make sure that special characters at
  88.                the start of lines are not eaten up by programs like
  89.                mailers.  If this option is used, the files will be
  90.                extracted with the stream editor sed rather than cat so
  91.                it is more efficient and portable to avoid setting the
  92.                prefix, though perhaps less safe if you don't know what
  93.                is in the files.
  94.  
  95.      SEE ALSO
  96.           tar(1), cpio(1), tp(1), sh(1)
  97.  
  98.      AUTHOR
  99.           Gary Perlman (based on a shell version by James Gosling,
  100.           with additions motivated by Derek Zahn, Michael Thompson, H.
  101.           Morrow Long, Fred Avolio, Gran Uddeborg, & Chuck Wegrzyn)
  102.  
  103.      LIMITATIONS
  104.           shar does not know anything about links between files or
  105.           binary files.
  106.  
  107.